Skip to content

Add Nix-based build environment, update CI pipeline to use it, add contribution guide #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Add Nix-based build environment, update CI pipeline to use it, add contribution guide #54

wants to merge 13 commits into from

Conversation

pulsastrix
Copy link
Member

@pulsastrix pulsastrix commented Sep 16, 2025 •
edited
Loading

Description

In an attempt to make working on libcoap-rs easier, this PR adds a Nix-based reproducible development environment using devenv.sh. This environment can be loaded directly (if you have the nix package manager installed) or by loading the newly defined dev container in a supported IDE (I tested with CLion and VS Code). The CI pipeline has also been rewritten accordingly so that we use the same environment for development and CI testing.

Additionally, I have written a contribution guide with the most important aspects of the libcoap-rs development workflow. This includes the environment setup, commit and PR guidelines, etc.
It also contains a proposed policy regarding LLM-generated code in libcoap-rs — feedback is very much welcome if you have some.

TODO: Before merging, I will also move some of the build instructions currently found in the libcoap-sys rustdoc into a dedicated BUILDING.md file and also improve these instructions in the process.

How to test

Follow the newly written contribution guide that can be found here to test the development environment. For JetBrains and VS Code, I have also added some run configurations for the Rust unit and integration tests.

As of now, I have only tested this on Linux; If one of the reviewers has the necessary hardware/software setup to do so, it would be great if you could test on Windows (with the devcontainer-based setup or WSL) and/or macOS (with a native Nix install or WSL) and report back any issues you have found.

@pulsastrix pulsastrix self-assigned this Sep 16, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 16, 2025 •
edited
Loading

Workflow Status Report

Generated for commit 6ecba47 on Tue Sep 16 23:16:32 UTC 2025.

Test and Analyze
Docs, Coverage Report and PR Updates

In case of failure, clippy warnings and rustfmt changes (if any) will be indicated as CI check warnings in the file comparison view.

Documentation: Read Online Download

Coverage Report: Read Online Download

Note: Online versions of documentation and coverage reports may not be available indefinitely, especially after the pull request was merged.

Code Coverage Report

Coverage

Coverage target is 80%.

Expand to view coverage statistics
file coverage covered missed_lines
libcoap-sys/src/lib.rs 77.78% 133 / 171 370-381, 489-492, 500, 527-544, 669-672, 756-759
libcoap/src/context.rs 59.52% 175 / 294 131, 196-241, 252-257, 275, 304, 351-355, 388, 403-404, 595-611, 645, 650, 666, 674-836
libcoap/src/crypto/pki_rpk/key.rs 56.32% 49 / 87 179-213, 242-250, 252-255, 261-263
libcoap/src/crypto/pki_rpk/mod.rs 26.44% 87 / 329 36-275, 454-486, 507-605, 613, 616, 650-668, 678-680, 685-687, 692-694, 755, 767-903
libcoap/src/crypto/pki_rpk/pki.rs 76.15% 99 / 130 90-149, 302-315
libcoap/src/crypto/pki_rpk/rpk.rs 68.33% 41 / 60 68-98, 160-171
libcoap/src/crypto/psk/client.rs 43.31% 55 / 127 71-75, 83, 106-192, 234-242, 269-271, 276-278, 306-338
libcoap/src/crypto/psk/key.rs 55.42% 46 / 83 42-49, 163-205
libcoap/src/crypto/psk/mod.rs 0.00% 0 / 24 30-96
libcoap/src/crypto/psk/server.rs 32.43% 48 / 148 70-89, 97, 100, 117-120, 146-148, 153-155, 160-162, 190-241, 262, 278-403
libcoap/src/error.rs 0.00% 0 / 6 148-228
libcoap/src/event.rs 29.73% 11 / 37 36-168
libcoap/src/lib.rs 0.00% 0 / 33 62-165
libcoap/src/mem.rs 72.56% 119 / 164 148-163, 196-198, 210-212, 280, 296-298, 319-324, 353-355, 369, 381-393, 454-456, 473, 481-488, 507, 527, 531
libcoap/src/message/mod.rs 57.37% 183 / 319 105-108, 110-131, 139-145, 147-168, 172, 174, 176, 208, 210, 213-222, 225-243, 245-249, 265-275, 295-302, 398-399, 441, 447, 478, 488-491, 497-499, 506, 511-523, 529, 549-551, 561-563
libcoap/src/message/request.rs 33.79% 99 / 293 51, 68-202, 228-256, 264-365, 371-375, 380-381, 383-386, 389, 395-400, 430-432, 436, 439-441, 444-446, 449, 452, 455, 458, 461, 472-479
libcoap/src/message/response.rs 22.17% 45 / 203 36-160, 165, 168, 171, 174, 177, 195-325, 329-334, 360
libcoap/src/prng.rs 54.79% 40 / 73 66, 78-116, 139-149, 196
libcoap/src/protocol.rs 33.33% 54 / 162 164-166, 171-176, 178-193, 195-196, 203-208, 210-225, 227-228, 285-287, 308, 322-324, 369-374, 383-388, 444-469, 475-488, 520, 522
libcoap/src/resource.rs 67.23% 160 / 238 62, 94-96, 171-176, 183-208, 214-219, 249, 266-288, 300-303, 319-339, 351-354, 387-396, 529-531
libcoap/src/session/client.rs 87.27% 96 / 110 168, 195, 262, 270-272, 278-280, 327-333
libcoap/src/session/mod.rs 41.13% 102 / 248 62-74, 105, 115-230, 240-285, 294-310, 319-330, 359, 363, 395-415, 437, 445, 477, 484, 502-508, 583, 589
libcoap/src/session/server.rs 80.88% 55 / 68 75-77, 81, 152, 162-164, 179, 194-200
libcoap/src/transport.rs 72.73% 16 / 22 29-36, 55
libcoap/src/types.rs 54.69% 268 / 490 71-125, 131-160, 210-243, 253-265, 272-278, 284-286, 295, 371, 411, 450, 562, 571, 583, 610, 636-705, 758, 803-824, 845-868, 879-964
libcoap/tests/common/dtls.rs 90.70% 39 / 43 49, 53-55
libcoap/tests/common/mod.rs 92.00% 69 / 75 85-88, 92, 126
libcoap/tests/dtls_pki_client_server_test.rs 100.00% 65 / 65
libcoap/tests/dtls_psk_client_server_test.rs 100.00% 21 / 21
libcoap/tests/dtls_rpk_client_server_test.rs 100.00% 6 / 6
libcoap/tests/tcp_client_server_test.rs 100.00% 17 / 17
libcoap/tests/udp_client_server_test.rs 100.00% 17 / 17

Total coverage: 53.21%

@pulsastrix pulsastrix marked this pull request as ready for review September 16, 2025 23:26
@pulsastrix pulsastrix requested review from JKRhb and falko17 September 16, 2025 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@falko17 falko17 Awaiting requested review from falko17

@JKRhb JKRhb Awaiting requested review from JKRhb

At least 1 approving review is required to merge this pull request.

Assignees

@pulsastrix pulsastrix

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@pulsastrix